/*
 * DG (DG Gaming Engine)  - API
 * Copyright (C) 2004  Bob Marks (marksie531@yahoo.com)
 * http://code.google.com/p/dng-gaming
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.dg.gaming.api.common.playerstate;

/**
 * Factory which creates a state from an integer defined in integer defined
 * in PlayerState.
 *
 * @author  Bob Marks
 * @version Alpha 0.2.3
 * @see     PlayerState
 */
public class PlayerStateFactory {

    /**
     * Factory method which returns a PlayerState object from a specied
     * integer state.
     *
     * @param state       State as an string.
     * @return            State as a PlayerState object.
     */
    public static PlayerState getState(String state) {

        if (state.equals(PlayerState.VIEWING)) {
            return new PlayerStateViewing();
        } else if (state.equals(PlayerState.SEATED)) {
            return new PlayerStateSeated();
        } else if (state.equals(PlayerState.READY_TO_START)) {
            return new PlayerStateReady();
        } else if (state.equals(PlayerState.GAME_STARTED)) {
            return new PlayerStateGameStarted();
        }

        return null;
    }
}
